Skip to content

Conversation

mjang
Copy link
Contributor

@mjang mjang commented Dec 23, 2024

Proposed changes

We're in the process of transferring most of our doc content to this repository, which will soon be publicly visible. (The remaining doc content is already available in other publicly visible open source repositories.)

This PR transfers that content.

In this PR, we'll test the build, to make sure what we see here is identical to what we see in our current internal repository.

After this PR is merged, I'll next address an internal issue where we'll "anonymize" the commits and committers to this repository. I'll then include an explanation of what we've done in the CONTRIBUTING.md file.

For the record, I cannot sign the F5 Contributor License Agreement until after we open this repository to the public. So that job will fail, and that's acceptable.

I've confirmed that the build works "locally" per the make commands described in the CONTRIBUTING_DOCS.md file.

nginx-jack and others added 30 commits October 10, 2024 14:19
This commit adds the DocOps engineering team to CODEOWNERS,
which should automatically tag them when requests affect the
.github folder.  

There are other specific files or folders they could likely be added to (such as the Makefile), but this should do for now given the frequency of GitHub Action development.
- Config Sync Groups
- Events
- Settings
- Expose certificates endpoints for publication
Co-authored-by: Travis Martin <33876974+travisamartin@users.noreply.github.com>
Co-authored-by: Travis Martin <33876974+travisamartin@users.noreply.github.com>
Chetan-99 and others added 21 commits December 12, 2024 13:50
Add fossa action.
This is a copy of the implementation from the NIC repo.
`FOSSA_TOKEN` secret has already been added to the repo.

Co-authored-by: Alan Dooley <a.dooley@f5.com>
- Need doc follow-up to describe the feature
### Proposed changes

Remove fossa while awaiting correct token
### Checklist

Before creating a PR, run through this checklist and mark each step as
complete.

- [ ] I have read the
[`CONTRIBUTING`](https://github.com/nginxinc/docs/blob/main/CONTRIBUTING.md)
document
- [ ] I have viewed my changes in the documentation Deploy Preview
- [ ] My PR is targeting the correct branch:
  - main: content that can be released immediately
- product release branch: content that should be held for a future
release
- [ ] I have updated any relevant supporting documentation
([`README.md`](https://github.com/nginxinc/docs/blob/main/README.md) and
the
[`CHANGELOG.md`](https://github.com/nginxinc/docs/blob/main/CHANGELOG.md))
- [ ] I have followed the [conventional commits
guidelines](https://www.conventionalcommits.org/en/v1.0.0/#summary) for
all commits on my branch

When you're ready to merge a PR, run through this checklist and mark
each step as complete.

- [ ] Review the doc for spelling errors.
- [ ] Verify that all links in the doc work.
- [ ] Verify that the doc follows the appropriate content template.
- [ ] Add technical and docs reviewers. Refer to the appropriate
CODEOWNERS file, which includes authorized teams of reviewers.
- [ ] Share the PR for review in the
[`#nginx-doc-reviews`](https://f5.enterprise.slack.com/archives/C04PYFULN91)
channel in Slack.
### Proposed changes

Add fossa and mend with workflow_dispatch only

### Checklist

Before creating a PR, run through this checklist and mark each step as
complete.

- [x] I have read the
[`CONTRIBUTING`](https://github.com/nginxinc/docs/blob/main/CONTRIBUTING.md)
document
- [x] I have viewed my changes in the documentation Deploy Preview
- [x] My PR is targeting the correct branch:
  - main: content that can be released immediately
- product release branch: content that should be held for a future
release
- [x] I have updated any relevant supporting documentation
([`README.md`](https://github.com/nginxinc/docs/blob/main/README.md) and
the
[`CHANGELOG.md`](https://github.com/nginxinc/docs/blob/main/CHANGELOG.md))
- [x] I have followed the [conventional commits
guidelines](https://www.conventionalcommits.org/en/v1.0.0/#summary) for
all commits on my branch

When you're ready to merge a PR, run through this checklist and mark
each step as complete.

- [x] Review the doc for spelling errors.
- [x] Verify that all links in the doc work.
- [x] Verify that the doc follows the appropriate content template.
- [x] Add technical and docs reviewers. Refer to the appropriate
CODEOWNERS file, which includes authorized teams of reviewers.
- [x] Share the PR for review in the
[`#nginx-doc-reviews`](https://f5.enterprise.slack.com/archives/C04PYFULN91)
channel in Slack.
### Proposed changes

Use correct secret names
### Checklist

Before creating a PR, run through this checklist and mark each step as
complete.

- [ ] I have read the
[`CONTRIBUTING`](https://github.com/nginxinc/docs/blob/main/CONTRIBUTING.md)
document
- [ ] I have viewed my changes in the documentation Deploy Preview
- [ ] My PR is targeting the correct branch:
  - main: content that can be released immediately
- product release branch: content that should be held for a future
release
- [ ] I have updated any relevant supporting documentation
([`README.md`](https://github.com/nginxinc/docs/blob/main/README.md) and
the
[`CHANGELOG.md`](https://github.com/nginxinc/docs/blob/main/CHANGELOG.md))
- [ ] I have followed the [conventional commits
guidelines](https://www.conventionalcommits.org/en/v1.0.0/#summary) for
all commits on my branch

When you're ready to merge a PR, run through this checklist and mark
each step as complete.

- [ ] Review the doc for spelling errors.
- [ ] Verify that all links in the doc work.
- [ ] Verify that the doc follows the appropriate content template.
- [ ] Add technical and docs reviewers. Refer to the appropriate
CODEOWNERS file, which includes authorized teams of reviewers.
- [ ] Share the PR for review in the
[`#nginx-doc-reviews`](https://f5.enterprise.slack.com/archives/C04PYFULN91)
channel in Slack.
### Proposed changes

Fix some broken links. Previous content now gone from Azure due to
purge.

### Checklist

Before creating a PR, run through this checklist and mark each step as
complete.

- [ ] I have read the
[`CONTRIBUTING`](https://github.com/nginxinc/docs/blob/main/CONTRIBUTING.md)
document
- [ ] I have viewed my changes in the documentation Deploy Preview
- [ ] My PR is targeting the correct branch:
  - main: content that can be released immediately
- product release branch: content that should be held for a future
release
- [ ] I have updated any relevant supporting documentation
([`README.md`](https://github.com/nginxinc/docs/blob/main/README.md) and
the
[`CHANGELOG.md`](https://github.com/nginxinc/docs/blob/main/CHANGELOG.md))
- [ ] I have followed the [conventional commits
guidelines](https://www.conventionalcommits.org/en/v1.0.0/#summary) for
all commits on my branch

When you're ready to merge a PR, run through this checklist and mark
each step as complete.

- [ ] Review the doc for spelling errors.
- [ ] Verify that all links in the doc work.
- [ ] Verify that the doc follows the appropriate content template.
- [ ] Add technical and docs reviewers. Refer to the appropriate
CODEOWNERS file, which includes authorized teams of reviewers.
- [ ] Share the PR for review in the
[`#nginx-doc-reviews`](https://f5.enterprise.slack.com/archives/C04PYFULN91)
channel in Slack.
### Proposed changes

Update NIM catalog data to 2.18 release. Copied from NIM
`release-2.18.0` branch.

### Checklist

Before creating a PR, run through this checklist and mark each step as
complete.

- [x] I have read the
[`CONTRIBUTING`](https://github.com/nginxinc/docs/blob/main/CONTRIBUTING.md)
document
- [x] I have viewed my changes in the documentation Deploy Preview
- [x] My PR is targeting the correct branch:
  - main: content that can be released immediately
- product release branch: content that should be held for a future
release
- [x] I have updated any relevant supporting documentation
([`README.md`](https://github.com/nginxinc/docs/blob/main/README.md) and
the
[`CHANGELOG.md`](https://github.com/nginxinc/docs/blob/main/CHANGELOG.md))
- [x] I have followed the [conventional commits
guidelines](https://www.conventionalcommits.org/en/v1.0.0/#summary) for
all commits on my branch

When you're ready to merge a PR, run through this checklist and mark
each step as complete.

- [x] Review the doc for spelling errors.
- [x] Verify that all links in the doc work.
- [x] Verify that the doc follows the appropriate content template.
- [x] Add technical and docs reviewers. Refer to the appropriate
CODEOWNERS file, which includes authorized teams of reviewers.
- [x] Share the PR for review in the
[`#nginx-doc-reviews`](https://f5.enterprise.slack.com/archives/C04PYFULN91)
channel in Slack.

---------

Co-authored-by: Travis Martin <33876974+travisamartin@users.noreply.github.com>
Co-authored-by: Mike Jang <mi.jang@f5.com>
### Proposed changes

This PR:

- Adds bold to "deprecated" notice for SLES 12 SP5 on R33

<img width="956" alt="image"
src="https://github.com/user-attachments/assets/87e37e82-446c-477a-810f-ddc74079330e"
/>
### Proposed changes

Need to add a newly invalid 3rd party URL to the linkchecker ignore
list. This is only used as an example and not an actual product link for
users. (Similar to www.example.com)


### Checklist

Before creating a PR, run through this checklist and mark each step as
complete.

- [ ] I have read the
[`CONTRIBUTING`](https://github.com/nginxinc/docs/blob/main/CONTRIBUTING.md)
document
- [ ] I have viewed my changes in the documentation Deploy Preview
- [ ] My PR is targeting the correct branch:
  - main: content that can be released immediately
- product release branch: content that should be held for a future
release
- [ ] I have updated any relevant supporting documentation
([`README.md`](https://github.com/nginxinc/docs/blob/main/README.md) and
the
[`CHANGELOG.md`](https://github.com/nginxinc/docs/blob/main/CHANGELOG.md))
- [ ] I have followed the [conventional commits
guidelines](https://www.conventionalcommits.org/en/v1.0.0/#summary) for
all commits on my branch

When you're ready to merge a PR, run through this checklist and mark
each step as complete.

- [ ] Review the doc for spelling errors.
- [ ] Verify that all links in the doc work.
- [ ] Verify that the doc follows the appropriate content template.
- [ ] Add technical and docs reviewers. Refer to the appropriate
CODEOWNERS file, which includes authorized teams of reviewers.
- [ ] Share the PR for review in the
[`#nginx-doc-reviews`](https://f5.enterprise.slack.com/archives/C04PYFULN91)
channel in Slack.
### Proposed changes

This PR:

- Adds linebreaks to commands for better human readability and to fix
scrolling issues
- Removes tabs in code blocks that impair the page layout
@mjang mjang requested review from a team as code owners December 23, 2024 18:04
@mjang mjang self-assigned this Dec 23, 2024
@mjang mjang merged commit c1fbd69 into main Dec 23, 2024
3 of 5 checks passed
@mjang mjang changed the title Transfer commits Transfer content Dec 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.